gdk: Add documentation

Add some useful information about event history.

diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 759f8a012880c6f4f54754a24d3b95298ae4d7a1..e67f5b66cbc5661527d879f06302cb4100c4ea57 100644 (file)
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -2899,6 +2899,12 @@ gdk_motion_event_new (GdkSurface      *surface,
  *
  * Retrieves the history of the @event, as a list of time and coordinates.
  *
+ * The history includes events that are not delivered to the application
+ * because they occurred in the same frame as @event.
+ *
+ * Note that only motion and scroll events record history, and motion
+ * events only if one of the mouse buttons is down.
+ *
  * Returns: (transfer container) (array length=out_n_coords) (nullable): an
  *   array of time and coordinates
  */